home *** CD-ROM | disk | FTP | other *** search
/ STraTOS 1997 April & May / STraTOS 1 - 1997 April & May.iso / CD01 / INTERNET / BROWSERS / WWW131 / SETUP / DOC / SCRIPTS.TXT < prev   
Encoding:
Text File  |  1996-06-01  |  6.2 KB  |  150 lines
  1. BETA 000
  2. --------
  3.  
  4. The UCDAVIS dialer script was too long to implement fully plus I 
  5. couldn't make head nor tail of it. The main bits are implemented but 
  6. the wierd stuff at the top will have to be added manually with a text 
  7. editor after config.prg has run successfully.
  8.  
  9. Script Candidates
  10. =================
  11.  
  12. A script must have all critical variables configured for the provider. 
  13. Neither can a script be user or modem specific. User and Modem 
  14. specific information must be generalised.
  15.  
  16. Maintenance
  17. ===========
  18.  
  19. The names and hierarchical positions of items within the SETUP 
  20. directory are best considered fixed. The programs within SETUP all 
  21. rely heavily on shel_read() to obtain their execution path - the term 
  22. current working directory (cwd) applies to this path *not* the path 
  23. which can be obtained from TOS which can easily be different when 
  24. multitasking. A point about shel_read() ...
  25.  
  26. shel_read() should return the full path including program name and 
  27. drive specification. Under Older Gem's it does not, it returns only 
  28. the program name which is useless. In order to maintain backwards 
  29. compatibility, the string returned from shel_read() is searched for a 
  30. ':' and if one is not found, Dgetdrv() and Dgetpath() are used and the 
  31. program name appended which emulates the newer shel_read() for all but 
  32. the silliest circumstances.
  33.  
  34. The batchfiles used all rely on the cwd. The cwd is obtained and the 
  35. path specified in the batchfile is appended to it to build a fully 
  36. specified name in all cases.
  37.  
  38. The rest of this text assumes that the contents of SETUP are unchanged 
  39. and that wherever the SETUP directory is written, that the user read 
  40. this as the full path to SETUP.
  41.  
  42. Adding a new Provider
  43. ---------------------
  44.  
  45. setup\install\provider.dat is a simple batchfile, one line per 
  46. provider. Each line consists of two fields - the first field is the 
  47. path to append to cwd and is delimited by a single space character. 
  48. The second field is all the remaining text until eol and is the actual 
  49. text to display in the list of providers which the user sees in the 
  50. install program. E.G.
  51.  
  52. scripts\newprov\install.dat New Provider
  53.  
  54. means that setup\install\scripts\newprov\install.dat is the batchfile 
  55. to use when installing for "New Provider" which will be visible to the 
  56. user to select. The full path built must not exceed 128 characters and 
  57. the length of the text to display in the provider list must not exceed 
  58. 40 characters currently.
  59.  
  60. Providers appear in the display window in the order that they appear 
  61. in provider.dat so it is recommended that the entries are manually 
  62. sorted into alphabetical order (case insensitive) when any non 
  63. alphabetical character preceeds an alphabetical one (ie 3<a etc).
  64. '
  65. The directory setup\install\scripts\newprov should be created. Copy 
  66. default.cfg and dial.scr into it and ensure that the dialer script 
  67. name in default.cfg is actually dial.scr.
  68.  
  69. Now either create setup\install\scripts\newprov\install.dat with a 
  70. text editor or copy one of the others and modify it.
  71.  
  72. install.dat consists of one line for each file to be copied, typically 
  73. two lines currently, one for default.cfg and one for dial.scr. Each 
  74. line consists of a source field and a destination field, separated by 
  75. a single space. The source field is a path relative to cwd, the 
  76. destination field consists simply of the destination filename (the 
  77. name can be changed during the copy but there is no reason to 
  78. complicate matters by actually doing so)
  79.  
  80. The provider is now part of the system. A point to note is that 
  81. install.prg copies the files unchanged to their destinations but 
  82. config.prg will strip out comments so the comments in the originals 
  83. might as well be removed.
  84.  
  85. A new provider script *must* have the following predefined:
  86.  
  87. ALLOCMEM    = 150000        reasonable general purpose value.
  88. SERIALPORT  = Modem 1        stands most chance of working.
  89. CDVALID     = TRUE        most modems support it.
  90. DIALFILE    = dial.scr        *must* be this.
  91. CLIENT_IP   = 0.0.0.0        *always* zero.
  92. TTL         = 64        leave all these unchanged ...
  93. PING_TTL    = 255
  94. MTU         = 1006
  95. MSS         = 966
  96. PKT_SIZE    = 2048
  97. DFB_SIZE    = 1024
  98. RCV_WND     = 4096
  99. UP_RESPONSE = 2            *must* be 2 without a good reason.
  100. USERNAME    = {nouser}        recommended text.
  101. HOSTNAME    = {nohost}        recommended text unless the provider 
  102.                 assigns dynamic IP in which case this 
  103.                 will be fixed and should be left 
  104.                 unchanged. If there is a fixed part to 
  105.                 the domain then it should be appended. 
  106.                 An example is {nohost}.demon.co.uk.
  107. FULLNAME    = {noname}        recommended text.
  108. NAMESERVER  = xxx.xxx.xxx.xxx    *must* be valid.
  109. IRCNICK     = {nonick}        recommended text.
  110. IRCSERVER   = {noserver}    recommended text.
  111. IRCPORT     = 6667        recommended text.
  112. IRCPONGMSG  = WWW installer!    recommended text.
  113. EMAIL       = {noemail}        recommended text.
  114. SMTP_HOST   = {nopost}        recommended text.
  115.  
  116. BAUD_RATE    = 19200        *never* exceed this.
  117. HANGUP       = ATH        recommended text.
  118. PREFIX       = ATDT        recommended text.
  119. INIT         = ATZ        recommended text.
  120. CONNECT_WAIT = 35        minimum value.
  121. REDIAL_DELAY = 20        minimum value.
  122. PHONE_NUMBER = 9549666        *always* remove PHONE_NUMBER variables!
  123. SUCCESS      = CDWAIT        *must* be present.
  124. FAILURE      = BUSY        *must* be present.
  125. FAILURE      = NO CARRIER    *must* be present.
  126. FAILURE      = NO DIALTONE    *must* be present.
  127. FIND         = ogin:        leave unchanged.
  128. RESP         = {nohost}        recommended text
  129. FIND         = word:        leave unchanged.
  130. RESP         = {password}    recommended text.
  131. FIND         = ocol:        leave unchanged.
  132. RESP         = slip        leave unchanged.
  133. FIND         = IP        if present, leave unchanged .
  134. RESP         = $GET_IP        if present, leave unchanged.
  135.  
  136. HTTP_PROXY and HTTP_PROXY_PORT *must* be left unchanged if supplied in 
  137. a script. If they do not exist, or they exist and are not valid, then 
  138. they *must* be removed from the script.
  139.  
  140. Archaic variables should be stripped to save confusing the end user. 
  141. Comments and blank lines are also stripped along the way so remove 
  142. these also.
  143.  
  144. Note
  145. ----
  146.  
  147. EMAIL and SMTP_HOST are supported currently so that Cab "mailto" can 
  148. be supported. They should not be considered permanent just yet, as a 
  149. future Cab may allow them to specified there.
  150.